Eventos

info

Os eventos são enviados via Webhooks. Clique aqui para saber mais sobre como receber eventos.

Evento: document.status.draft

Evento emitido assim que o documento é criado, mas as assinaturas ainda não foram solicitadas aos signatários.

Corpo do Evento

{
  "eventId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
  "eventName": "document.status.draft",
  "attributes": {
    "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
    "type": "documents",
    "businessId": "DOCUMENTO-1234567",
    "status": "draft",
    "signers": [
      {
        "businessId": "CLIENTE-1234567",
        "name": "Fulano de Tal",
        "email": "fulano@example.com"
      }
    ],
    "originalFile": "https://s3...",
    "signedFile": "https://s3..."
  }
}

Descrição dos Campos

Campo	Descrição
eventId	Identificador único do evento, no formato UUID.
eventName	Nome do evento, indicando a ação realizada, por exemplo, "document.status.signed".
attributes.id	Identificador único do documento, no formato UUID.
attributes.type	Tipo do item, neste caso, "document".
attributes.businessId	Identificador de negócios do documento, como um código ou número de referência.
attributes.status	Estado atual do documento, por exemplo, "signed" (assinado).
attributes.signers[].businessId	Identificador de negócios do signatário, como um código ou número de referência.
attributes.signers[].name	Nome do signatário.
attributes.signers[].email	Endereço de email do signatário.
attributes.originalDocumentFile	URL para o arquivo do documento original.
attributes.signedDocumentFile	URL para o arquivo do documento assinado.

Evento: document.status.pending

Evento emitido quando o documento está aguardando as assinaturas.

Corpo do Evento

{
  "eventId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
  "eventName": "document.status.pending",
  "attributes": {
    "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
    "type": "documents",
    "businessId": "DOCUMENTO-1234567",
    "status": "pending",
    "signers": [
      {
        "businessId": "CLIENTE-1234567",
        "name": "Fulano de Tal",
        "email": "fulano@example.com"
      }
    ],
    "originalFile": "https://s3...",
    "signedFile": "https://s3..."
  }
}

Descrição dos Campos

Campo	Descrição
eventId	Identificador único do evento, no formato UUID.
eventName	Nome do evento, indicando a ação realizada, por exemplo, "document.status.signed".
attributes.id	Identificador único do documento, no formato UUID.
attributes.type	Tipo do item, neste caso, "document".
attributes.businessId	Identificador de negócios do documento, como um código ou número de referência.
attributes.status	Estado atual do documento, por exemplo, "signed" (assinado).
attributes.signers[].businessId	Identificador de negócios do signatário, como um código ou número de referência.
attributes.signers[].name	Nome do signatário.
attributes.signers[].email	Endereço de email do signatário.
attributes.originalDocumentFile	URL para o arquivo do documento original.
attributes.signedDocumentFile	URL para o arquivo do documento assinado.

Evento: document.status.signed

Evento emitido quando todos os signatários assinarem o documento.

Corpo do Evento

{
  "eventId": "dca749e9-e60e-490e-936a-64fbc6eb67f9",
  "eventName": "document.status.signed",
  "attributes": {
    "id": "c58a0dc6-f862-40eb-92cd-20922d1d618a",
    "type": "documents",
    "businessId": "DOCUMENTO-1234567",
    "status": "signed",
    "signers": [
      {
        "businessId": "CLIENTE-1234567",
        "name": "Fulano de Tal",
        "email": "fulano@example.com"
      }
    ],
    "originalFile": "https://s3...",
    "signedFile": "https://s3..."
  }
}

Descrição dos Campos

Campo	Descrição
eventId	Identificador único do evento, no formato UUID.
eventName	Nome do evento, indicando a ação realizada, por exemplo, "document.status.signed".
attributes.id	Identificador único do documento, no formato UUID.
attributes.type	Tipo do item, neste caso, "document".
attributes.businessId	Identificador de negócios do documento, como um código ou número de referência.
attributes.status	Estado atual do documento, por exemplo, "signed" (assinado).
attributes.signers[].businessId	Identificador de negócios do signatário, como um código ou número de referência.
attributes.signers[].name	Nome do signatário.
attributes.signers[].email	Endereço de email do signatário.
attributes.originalDocumentFile	URL para o arquivo do documento original.
attributes.signedDocumentFile	URL para o arquivo do documento assinado.